Como crear un Retiro
POST - https://url.base/api/withdrawal/pix/new
Endpoint para crear una nuevo retiro. Para crear una nueva solicitud de retiro,
la solicitud debe construirse con los siguientes parámetros.
(*) Información requerida..
Campo | Tipo | Descripción |
---|---|---|
*amount | Integer | Monto de la transacción. |
*document_id | String | Documento de identidad del beneficiario |
*beneficiaryName | Integer | Nombre completo del beneficiario |
*beneficiaryLastName | String | Apellido del beneficiario |
*beneficiaryEmail | String | Correo electrónico del beneficiario |
*beneficiaryPhone | String | Número de teléfono del beneficiario. |
*accountNumber | String | Número de cuenta bancaria |
*accountType | String | Tipo de cuenta bancaria |
*bankCode | String | Código bancario |
*data | String | Identificador del Retiro a asociar. El campo "data" debe ser único e irrepetible |
*confirmationURL | Link | URL para la confirmación de la transacción |
*currency | String | Código de moneda ISO. # Países y monedas |
*country | String | Formato de país internacional. # Países y monedas |
*sign | String | La firma de los parámetros es única para cada transacción |
*pagamentoType | Integer | Este es el campo diferenciador al solicitar un retiro PIX. El Valor (1) corresponde a un retiro con una cuenta bancaria, mientras que el Valor (2) es un retiro con una clave PIX |
*Type | String | Este campo diferencia qué tipo de PIX se utilizará al generar el retiro, y se debe distinguir por 'document_id (CPF)' o 'beneficiaryEmail' o 'beneficiaryPhone' |
accountNumber | String | Número de cuenta bancaria (Solo tipo de pago 1) |
agency | String | Sucursal bancaria brasileña donde se realizará el retiro para el tipo de pago 2, retiro a cuenta bancaria (Solo tipo de pago 1) |
ispb | String | la ispbParticipante de la institución financiera asociada al contacto. (Solo tipo de pago 1) |
info
Una vez que el usuario haya completado el proceso de retiro, ProntoPaga devolverá los datos a la URL que hayas especificado en la urlConfirmación
Response OK
{
"uid" = [string] // Identificador de retirada en el sistema,
"status" = [string] // Estado del retiro,
"data" = [string] // Datos adicionales de la transacción
}
Status response
Campo | Descripción |
---|---|
200 -201: OK | Retiro creado con éxito |
401: Unauthorized | Permiso denegado |